跳至主要内容
版本:V4.1

報修管理API


獲取報修列表​

接口地址​

POST /api/v1.0/invoke/open-ability/method/user-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型,值爲application/json
AcceptStringHeader是接受類型,值爲application/json
AuthorizationStringHeader是Bearer認證,訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
residence_idStringBody是住宅ID

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型,值爲application/json
successBooleanBody判斷請求是否成功
true:成功
false:失敗
timestampIntegerBody時間戳
result[]Object<result>Body返回結果

result說明​

參數名類型位置說明
maintenance_idStringBody報修ID
start_timeStringBody開始時間,UTC
finish_timeStringBody結束時間,UTC
descriptionStringBody描述
contactStringBody聯繫人
maintenance_picture_url[]StringBody報修圖片地址
feedbackStringBody反饋
stateStringBody狀態
wait for confirmation:待確認
in progress:進行中
completed:已完成
closed:已關閉
created_timeStringBody創建時間,UTC

請求示例​

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "get_maintenance_list",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
}
}

成功返回示例​

狀態碼:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": [
{
"maintenance_id": "m31adc223cc4b3bedb6bd4742dedcfa52",
"start_time": "2024-01-16 13:32:45",
"finish_time": "2024-01-17 13:32:45",
"description": "test",
"contact": "10086",
"maintenance_picture_url": [
"https://test.akubela.com/p"
],
"feedback": "test",
"state": "in progress",
"created_time": "2024-01-12 13:32:45"
}
]
}

失敗返回示例​

見 接口失敗返回



獲取報修信息​

接口地址​

POST /api/v1.0/invoke/open-ability/method/user-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型,值爲application/json
AcceptStringHeader是接受類型,值爲application/json
AuthorizationStringHeader是Bearer認證,訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
residence_idStringBody是住宅ID
maintenance_idStringBody是報修ID

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型,值爲application/json
successBooleanBody判斷請求是否成功
true:成功
false:失敗
timestampIntegerBody時間戳
resultObject<result>Body返回結果

result說明​

參數名類型位置說明
start_timeStringBody開始時間,UTC
finish_timeStringBody結束時間,UTC
descriptionStringBody描述
contactStringBody聯繫人
maintenance_picture_url[]StringBody報修圖片地址
feedbackStringBody反饋
stateStringBody狀態
wait for confirmation:待確認
in progress:進行中
completed:已完成
closed:已關閉
created_timeStringBody創建時間,UTC

請求示例​

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "get_maintenance_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
"maintenance_id": "m31adc223cc4b3bedb6bd4742dedcfa52"
}
}

成功返回示例​

狀態碼:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {
"start_time": "2024-01-16 13:32:45",
"finish_time": "2024-01-17 13:32:45",
"description": "test",
"contact": "10086",
"maintenance_picture_url": [
"https://test.akubela.com/p"
],
"feedback": "test",
"state": "in progress",
"created_time": "2024-01-12 13:32:45"
}
}

失敗返回示例​

見 接口失敗返回



創建報修信息​

接口地址​

POST /api/v1.0/invoke/open-ability/method/user-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型,值爲application/json
AcceptStringHeader是接受類型,值爲application/json
AuthorizationStringHeader是Bearer認證,訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
residence_idStringBody是住宅ID
start_timeStringBody是開始時間,UTC
finish_timeStringBody是結束時間,UTC
descriptionStringBody是描述
contactStringBody是聯繫人
filename[]StringBody否文件名

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型,值爲application/json
successBooleanBody判斷請求是否成功
true:成功
false:失敗
timestampIntegerBody時間戳
resultObject<result>Body返回結果

result說明​

參數名類型位置說明
maintenance_idStringBody報修ID

請求示例​

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "create_maintenance_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
"start_time": "2024-01-16 13:32:45",
"finish_time": "2024-01-17 13:32:45",
"description": "test",
"contact": "10086",
"filename": [
"f8b5a73f8dd84abaa94dcs248be49b0db"
]
}
}

成功返回示例​

狀態碼:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {
"maintenance_id": "m8b5a73f8dd84abaa94dcs248be49b0d1"
}
}

失敗返回示例​

見 接口失敗返回



刪除報修信息​

接口地址​

POST /api/v1.0/invoke/open-ability/method/user-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型,值爲application/json
AcceptStringHeader是接受類型,值爲application/json
AuthorizationStringHeader是Bearer認證,訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
residence_idStringBody是住宅ID
maintenance_idStringBody是報修ID

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型,值爲application/json
successBooleanBody判斷請求是否成功
true:成功
false:失敗
timestampIntegerBody時間戳
resultObjectBody返回結果

請求示例​

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "delete_maintenance_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
"maintenance_id": "m8b5a73f8dd84abaa94dcs248be49b0d1"
}
}

成功返回示例​

狀態碼:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {}
}

失敗返回示例​

見 接口失敗返回



批量刪除報修信息​

接口地址​

POST /api/v1.0/invoke/open-ability/method/user-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型,值爲application/json
AcceptStringHeader是接受類型,值爲application/json
AuthorizationStringHeader是Bearer認證,訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
residence_idStringBody是住宅ID
maintenances[]Object<maintenance>Body是報修信息

maintenance說明​

參數名類型位置必填說明
maintenance_idStringBody是報修ID

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型,值爲application/json
successBooleanBody判斷請求是否成功
true:成功
false:失敗
timestampIntegerBody時間戳
resultObjectBody返回結果

請求示例​

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "batch_delete_maintenance_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
"maintenances": [
{
"maintenance_id": "m8b5a73f8dd84abaa94dcs248be49b0d1"
}
]
}
}

成功返回示例​

狀態碼:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {}
}

失敗返回示例​

見 接口失敗返回